dxp-ux

This operation provides following features for

PR:

1. will create the AddLine Order in Salesforce
2. AddOn create request towards Salesforce
3. To turn on or off e-bill entity

PA:

1. To buy a plan for prepaid customers.

URL

https://[localhost]:[port]/dxp-ux/v1/{businessId}/productOrder

URL PARAMS

Header

Data Model - Request:

Each of the request parameters is detailed.

channel[] subResource request dataModel:

productOrderItem subResource request dataModel:

productOrderItem[].product.productCharacteristic[] subResource request and response dataModel:

note subResource - dataModel:

CONSENTS productCharacteristic values for PR- AddLine usecase:

Note for PR AddLine usecase : Only 'GeneralTnC' is mandatory, Others optional depends on order

DELIVERY-ADDRESS productCharacteristic values for PR- AddLine usecase:

LINE-DETAILS productCharacteristic values for PR- AddLine usecase:

CREDIT-DETAILS productCharacteristic values for PR- AddLine usecase:

Note for PR AddLine usecase: All three credit check parameters together are mandatory OR all of them together optional.

PAYMENT-DETAILS productCharacteristic values for PR- AddLine usecase:

Data Model - Response:

Each of the response parameters is detailed.

productOrderItem subResource response dataModel:

Key Considerations :

• Please refer the examples from the following URL - DXP UX - POST ProductOrder

PA Implementation:

1. This implementation is used to buy a plan for prepaid users.
2. Following are the mandatory fields in the request payload:
   - payload.category - should be sent as "PREPAID" (to identify the type of user).
   - channel[].id (to identify the channel).
   - productOrderItem[].product.productCharacteristic[].name (should be "MSISDN") and productOrderItem[].product.productCharacteristic[].value (This is MSISDN value).
   - productOrderItem[].productOffering.id (This is the Offer ID).
3. Possible values for productOrderItem[].action in request payload is "add". If the field productOrderItem[].action is not provided in the request, default value will be considered as "add".
4. This implementation accepts only one offer per request.
5. For all the dateTime fields
   - Any datetime before 1908-04-22 will show offset -05:18
   - Any datetime on or after 1908-04-22 will show offset -05:00

PR Implementation:

1. Create Order - Add Line:
    - To work this functionality, the field "@type" not empty and value must be equal to "AddLine" in request body
    - Salesforce will acknowledge in success scenario ( it's not a real time transaction response )
2. e-bill usecase:
     - If the customer need to enable paper bill (disable ebill), in the request productOrderItem.action need to be pass as "add" and if need to disable the paper bill(enable ebill) pass productOrderItem.action as "delete"

Possible Error scenarios for PA:

When order creation is rejected

{
    "category": "PREPAID",
    "orderDate": "2023-10-23T05:27:28.261-05:00",
    "cancellationReason": "Disculpe, no tiene saldo suficiente para activarse en el Plan Ilimitado +Movil",
    "state": "rejected",
    "productOrderItem": [
        {
            "id": "1",
            "quantity": 1,
            "action": "add",
            "productOffering": {
                "id": "1234",
                "name": "",
                "@referredType": "CampaingOffer"
            },
            "product": {
              "productCharacteristic": [{
                "name": "MSISDN",
                "value": "69877689"
              }]
            }
        }],
    "@type": "ProductOrder"
}

If offerID is invalid or offer details are not found

{
    "errors": [
        {
            "code": 404,
            "message": "LLA:NOT_FOUND",
            "description": "The requested offer details could not be found."
        }
    ]
}

Possible Error Scenarios for PR:

[400 ]

{
    "errors": [
        {
            "code": 400,
            "message": "SF:POST_PRODUCTORDER",
            "description": "Required parameters missing"
        }
    ]
}